-
Notifications
You must be signed in to change notification settings - Fork 29.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: add "building node with ninja" guide #4767
Conversation
cc @nodejs/documentation |
Thanks for PR'ing this in! The Docs WG is going to discuss next steps on adding guides in tomorrows meeting at 10AM PST; we'll take action on the PR shortly after that. |
|
||
The purpose of this guide is to show how to build Node.js using [Ninja][], as doing so can be much quicker than using `make`. Please see [Ninja's site][Ninja] for installation instructions (unix only). | ||
|
||
To build Node with ninja, there are 4 steps that must be taken: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Throw in a newline after this so markdown knows it's a list. Same on line 11.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, my preview works fine, maybe it's just github. Oh well.
Please word-wrap at 80 characters, as per https://github.com/nodejs/docs/blob/master/STYLE-GUIDE.md |
@bengl 80 characters does not work for lists. The list will force a newline. :/ |
@Fishrock123 I don't think that's so — for example:
Source: * Hello there.
I am wrapped.
* I am wrapped too
But it's okay. Edit, if that's too ugly:
* Hello there.
I am wrapped.
* I am wrapped too
But it's okay. Will work too! |
@chrisdickinson I don't think this is necessarily consistent between parsers/renderers then: (Atom's markdown preview) |
@bengl I consolidated the instructions into one list. :) |
@Fishrock123 you mention a few times how much faster it is -- out of curiosity, could you quantify it? |
@jbergstroem you mean I'd say it's at least 40% faster |
@Fishrock123 so |
@jbergstroem well, that's how much faster it feels so maybe it isn't idk. |
Just tested it locally:
|
ping @bengl & @chrisdickinson |
ok LGTM 👍 |
@bengl Updated a bit (I wasn't comfortable with some statements), PTAL. @chrisdickinson I still haven't shortened the lines... do we need to take it back to the docs WG? My editor renderer does not render split lines very nicely. |
I'm going to land this tomorrow (Tuesday) unless there is additional review. We can fix any problems with it after I guess. |
Whoops, missed this. Yep, LGTM. |
@chrisdickinson do doc wg members officially have sign-off rights for |
LGTM too. 👍 |
PR-URL: nodejs#4767 Refs: nodejs/docs#38 Reviewed-By: Bryan English <bryan@bryanenglish.com> Reviewed-By: Stephan Belanger <admin@stephenbelanger.com>
0d503d2
to
65c0feb
Compare
PR-URL: #4767 Refs: nodejs/docs#38 Reviewed-By: Bryan English <bryan@bryanenglish.com> Reviewed-By: Stephan Belanger <admin@stephenbelanger.com>
PR-URL: #4767 Refs: nodejs/docs#38 Reviewed-By: Bryan English <bryan@bryanenglish.com> Reviewed-By: Stephan Belanger <admin@stephenbelanger.com>
PR-URL: #4767 Refs: nodejs/docs#38 Reviewed-By: Bryan English <bryan@bryanenglish.com> Reviewed-By: Stephan Belanger <admin@stephenbelanger.com>
PR-URL: #4767 Refs: nodejs/docs#38 Reviewed-By: Bryan English <bryan@bryanenglish.com> Reviewed-By: Stephan Belanger <admin@stephenbelanger.com>
PR-URL: #4767 Refs: nodejs/docs#38 Reviewed-By: Bryan English <bryan@bryanenglish.com> Reviewed-By: Stephan Belanger <admin@stephenbelanger.com>
People always ask me about how to do this, and there's no good info about it really anywhere.
Moving from nodejs/docs#38